DescribeVSwitches - 获取指定VPC内的虚拟交换机列表

调用DescribeVSwitches获取指定地域,指定VPC内的虚拟交换机列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
VpcIdstring

VPC ID。

vpc-bp17gig441u0msmd78****

返回参数

名称类型描述示例值
object

Schema of Response

TotalCountinteger

TotalCount 本次请求条件下的数据总量。此参数为可选参数,默认可不返回。

10
RequestIdstring

请求 ID。

BD65C0AD-D3C6-48D3-8D93-38D2015C****
NextTokenstring

表示当前调用返回读取到的位置。显示为空表示数据已经读取完毕。

“”
MaxResultsinteger

本次请求所返回的最大记录条数。

10
VSwitchesobject []

可用的虚拟交换机列表。

VpcIdstring

交换机所在 VPC 的 ID。

vpc-bp17gig441u0msmd6****
VSwitchIdstring

虚拟交换机 ID。

vsw-bp1g24p9no0iqir46****
Statusstring

虚拟交换机的状态,取值:

  • Pending:配置中。
  • Available:可用。
Available
IsDefaultboolean

是否是默认交换机,取值:

  • true:默认交换机。

  • false:不是默认交换机。

false
VSwitchNamestring

虚拟交换机名称。

vsw-test
ZoneIdstring

交换机所属的可用区。

cn-hangzhou-k

示例

正常返回示例

JSON格式

{
  "TotalCount": 10,
  "RequestId": "BD65C0AD-D3C6-48D3-8D93-38D2015C****",
  "NextToken": "“”",
  "MaxResults": 10,
  "VSwitches": [
    {
      "VpcId": "vpc-bp17gig441u0msmd6****",
      "VSwitchId": "vsw-bp1g24p9no0iqir46****",
      "Status": "Available",
      "IsDefault": false,
      "VSwitchName": "vsw-test",
      "ZoneId": "cn-hangzhou-k"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-04-12OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更